home *** CD-ROM | disk | FTP | other *** search
/ Aminet 19 / Aminet 19 (1997)(GTI - Schatztruhe)[!][Jun 1997].iso / Aminet / comm / www / ScanWWW.lha / ScanWWW / ScanWWW.doc < prev    next >
Text File  |  1997-02-23  |  10KB  |  300 lines
  1.                                  ScanWWW V1.4
  2.                                  ============
  3.  
  4. Author: Sebastian Rieger
  5. Requirements: any Ami, KS1.3, FTPMount 1.0, TCP/IP (AmiTCP,Miami...)
  6.               (for FTPMount see chapter "6.How to install FTPMount?")
  7.  
  8.  
  9. *****************************************************************************
  10.  
  11. First of all... this is the first release of ScanWWW further improvements
  12. are planned!
  13.  
  14. Please support the shareware idea!
  15.  
  16. *****************************************************************************
  17.  
  18.  
  19.  
  20. Table of contents
  21. *****************
  22.  
  23. 1. What is ScanWWW?
  24. 2. Why is it shareware?
  25. 3. How does it work?
  26. 4. What is a local webserver?
  27. 5. How to install ScanWWW?
  28. 6. How to install FTPMount?
  29. 7. How to use ScanWWW?
  30. 8. How to configure ScanWWW?
  31. 9. How to contact the author?
  32. 10.Future improvements
  33. 11.History
  34.  
  35.  
  36. What is ScanWWW?
  37. ================
  38. ScanWWW alows you to update your webserver or your private homepage. It scans
  39. a local directory for new files, which have not yet been transfered to the
  40. internet. Then it simply copies them over to your host. It also allows you
  41. to get certain files from your host e.g. the counter or a transfer logfile.
  42.  
  43.  
  44.  
  45.  
  46. Why is it shareware?
  47. ====================
  48. Because it is very handy ;-) No! I need some support to keep up programming
  49. for the Amiga. As you might notice, I`m also the programmer of UpToDate,
  50. which is available form Oberland Computer. But there isn`t that market for
  51. Amiga software as there was some years ago... The shareware fee is not that
  52. expensive it`s just 20 DM / 10 $ / 10 sFr / 140 Ös. You can send the money
  53. via snail mail (post) to the following address, or send a money order...
  54. or transfer it to my bank account... i only need it ;-) Then I will send
  55. you your keyfile via EMail. If you wish to get it via snail mail (post)
  56. you have to add the shipping costs. Don`t forget to mention your EMail
  57. Address or postal address otherwise i won`t know whom to send it ;-))
  58.  
  59. Post
  60. ----
  61. Sebastian Rieger
  62. Untere Steinkuhle 10
  63. 31061 Alfeld
  64.  
  65. EMail
  66. -----
  67. s.rieger@alfeld.de
  68.  
  69. Bank:
  70. -----
  71. Kreissparkasse ALFELD
  72. Bank Nr.: 259 510 20
  73. Account Nr.: 100082643
  74. Name: Sebastian Rieger
  75.  
  76.  
  77.  
  78. How does it work?
  79. =================
  80. After the update process it sets the archive flag of every file. Yes! You
  81. got it! It manages everything by the archive flag! This flag is unset 
  82. everytime you save a file. If you edit any file and save it again the
  83. archive flag will be unset. Please note, that if you copy any external
  84. files to your local host directory you have to unset the archive flag (it`s
  85. usually already unset!). You can see the archive flag by using the list
  86. command or any directory utility (like DirOpus). You`ll see something like
  87. ----RWED these are the file attributes. The character in front of the R
  88. has to be A for the file to be archived. For example ---ARWED. Consult your
  89. AmigaDOS/Workbench manual if you want to know more about attributes.
  90.  
  91.  
  92.  
  93.  
  94. What is a local webserver?
  95. ==========================
  96. Ever heard this term? It`s just a local image (copy) of all the directories
  97. and files on your webserver. It`s that simple! If you use local refers as
  98. "../index.html" in your HTML-Files, you will be able to browse through your
  99. web localy! The only thing you have to use then are local references. A
  100. link to www.your.host/dir/doc.htm has to be <A HREF="dir/doc.htm"></A>. If
  101. you want to linik back to your homepage you have to use a parent mark 
  102. "../". <A HREF="../index.html"></A>. Then you get from 
  103. www.your.host/dir/doc.htm to www.your.host/index.html. The same applies to
  104. images. (<IMG SRC="../pic.jpg">.
  105.  
  106.  
  107.  
  108.  
  109. How to install ScanWWW?
  110. =======================
  111. Simply start its installer script
  112.  
  113.  
  114.  
  115.  
  116. How to install FTPMount?
  117. ========================
  118. You can find FTPMount via AmiNet. It mounts a logical device FTP: on your
  119. Workbench. Unpack its archive. Start the installation script. There aren`t
  120. any very difficult questions along the installation. After this step take a
  121. look in the directory, you installed it in. You will find a drawer called 
  122. "hosts". In this dir all the hosts that are reachable via FTPMount are stored. 
  123. Every directory is a configuration for a server. First you have to create a 
  124. new drawer in this path. Make sure that you have also created an icon for 
  125. the new drawer. The whole configuration is done via tooltypes. Usually you
  126. would need to mention three tooltypes:
  127.  
  128. HOST=ftp.yourhost.com
  129. USER=loginname
  130. PASSWORD=passi
  131.  
  132. The HOST tooltype defines the location of your webserver in the internet.
  133. USER defines the required user for the webhost, which has got the rights
  134. to change files on your server. PASSWORD just defines the needed password
  135. for this user. You can also leave the PASSWORD tooltype unset. Then you will
  136. be asked for the password everytime you perform a login.
  137.  
  138.  
  139.  
  140.  
  141. How to use ScanWWW?
  142. ===================
  143. If you`ve already red the previous part of this manual, then you already know
  144. how to use the file attributes. ScanWWW can be started either from the shell
  145. or from the Workbench (using its icon). After the scanning process you have
  146. to press RETURN to start the update of your webserver. It will copy every
  147. file which is marked with a ">" in front of its path/file. 
  148.  
  149. >index.html (will be copied)
  150.  index.html (won`t be copied)
  151.  
  152.  
  153.  
  154.  
  155. How to configure ScanWWW?
  156. =========================
  157. It`s very simple! There are two files you have to edit. Please note that every
  158. file has to end with a blank line! So press enter after the last line you
  159. typed in!
  160. Both files are copied to ENVARC:. 
  161.  
  162.  
  163. ENVARC:ScanWWW.prefs
  164. --------------------
  165.  
  166. consists of 5 lines:
  167.  
  168. LocalScanPath=work2:webpages/regalfeld
  169. RemotePath=ftp:alfeld
  170. ConnectCommand=execute dh1:startinet
  171. DisconnectCommand=execute dh1:stopinet
  172. GetFileDestination=work2:webpages/transfer
  173.  
  174. 1.Line  The LocalScanPath is the path where your local copy of your webserver
  175.         resides. Please note that you have to use the logical device! The
  176.         logical device is the name of the Volume. For example you have got
  177.         dh0: and dh1: (or something like this...) and their names are
  178.         Boot and Work. So you have to use these names Boot: or Work: followed
  179.         by the directory. Do not add any "/" at the end of the line!
  180.  
  181. 2.Line  RemotePath. ftp: stands for the FTPMount device. Alfeld stands for
  182.         the config dir of FTPMount. See the FTPMount Manual if you do not
  183.         know how to add a new FTP server. To give you a short explantation:
  184.         The RemotePath (after ftp:) has to be a directory in the directory
  185.         FTPMount:Hosts. There is usualy e.g. a directory called aminet
  186.         already existent. You can analyse its icon tooltypes to see how you
  187.         can configure your own drawer/host. Do not add any "/" at the end 
  188.         of the line!
  189.  
  190. 3.Line  Connect command. For example "execute dh1:startinet". This command
  191.         is executed if you select "Yes" when you want to connect the internet.
  192.         Scripts or ARexx-Scripts are available for every TCP/IP Stack.
  193.         For AmiTCP you can use: 
  194.         ConnectCommand=execute amitcp:bin/startnet
  195.         DisconnectCommand=execute amitcp:bin/stopnet
  196.  
  197. 4.Line  Disconnect command. Ths command is executed if you want to diconnect
  198.         the internet.
  199.  
  200. 5.Line  The directory where you want to store the files you get from your
  201.         webserver. Remember that you have to have the whole directory
  202.         structure of your webserver in ths path. If your want to get
  203.         logs/transfer.log from your webserver then the directory logs
  204.         has to be created in the Path defined by Line 5 before you can
  205.         get the files. Please note that you have to use the logical device! The
  206.         logical device is the name of the Volume. For example you have got
  207.         dh0: and dh1: (or something like this...) and their names are
  208.         Boot and Work. So you have to use these names Boot: or Work: followed
  209.         by the directory. Do not add any "/" at the end of the line!
  210.  
  211.  
  212. ENVARC:ScanWWWGet.prefs
  213. -----------------------
  214. consists of as many lines as you need. Please consider that you have to have a
  215. blank line at the end of the file!
  216. Every line has a certain header:
  217. AD[Path+File]
  218.  
  219. Example file:
  220. A Access.log
  221. ADlogs/transfer.log
  222.   count.txt
  223.  Dregs/regfile.txt
  224.  
  225. The A stands for ADD while the D stands for DELETE. If you set an A at the
  226. beginning of the line, the given file (here Access.log) will be ADDED to the
  227. one stored on your local harddisc. If you type a D in the second column the
  228. file will be removed from your webserver. You can combine the two attributes
  229. or leave them totally untouched.
  230.  
  231.  
  232.  
  233. ENVARC:ScanWWWRej.prefs
  234. -----------------------
  235. This file contains all paths which will be rejected to upload. This function
  236. is very usefull when you are working together with some people on the same
  237. homepage.
  238. Just give the relative paths. For example:
  239. If you used work:webpages/ as your local webserver which contains:
  240. work:webpages/first
  241. work:webpages/first/a
  242. work:webpages/first/b
  243. work:webpages/second
  244. work:webpages/third
  245.  
  246. If you enter in your ENVARC:ScanWWWRej.prefs file the following lines:
  247.  
  248. first/a
  249. third
  250.  
  251. then ScanWWW will only copy changed files from 
  252.  
  253. work:webpages/first/
  254. work:webpages/first/b
  255. work:webpages/second/
  256.  
  257.  
  258.  
  259.  
  260. How to contact the author?
  261. ==========================
  262. s.rieger@alfeld.de
  263. Sebastian Rieger
  264. Untere Steinkuhle 10
  265. 31061 Alfeld
  266.  
  267.  
  268.  
  269.  
  270. Future releases
  271. ===============
  272. - will include a prefs editor (call me lazy, but I think you`ll manage it ;-))
  273. - an improvement of the filter feature
  274. - a special version in German ;-)
  275.  
  276.  
  277.  
  278. History
  279. =======
  280. V1.4      - Published via AmiNet
  281.           - separate config program
  282.           - separate reject file
  283.           - removed sorting bug / makedir bug
  284.  
  285. V1.3      - separate configfiles
  286.           - fixed a nasty sorter bug
  287.           - the files are now selectable
  288.           - no longer limited to private use
  289.  
  290. V1.2      - possibility to Quit everytime
  291.           - implemented RETURN query
  292.  
  293. V1.1      - additional requesters
  294.           - refreshed the doc after scanning
  295.  
  296. V1.0      - first release
  297.  
  298. # The author doesn`t take any responsibilities for damages caused by ScanWWW
  299. # ...because it works! i use it every day! ;-)
  300.